home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-13 / wwived23.zip / WWIVEDIT.DOC < prev    next >
Text File  |  1992-04-19  |  21KB  |  529 lines
  1.  
  2.  
  3.                               WWIVEdit Version 2.3
  4.                   By Adam Caldwell (1@16470 Link, 1@6470 Net)
  5.  
  6.  
  7.                                    OVERVIEW
  8.  
  9.          WWIVEdit is a full screen editor designed for WWIV 4.xx BBS
  10.     system.  WWIVEdit has many of the bells and whistles of a regular
  11.     word processor, plus it supports some WWIV specific things, such as
  12.     Colors, a Two-Way chat mode, and Macros.  WWIVEdit is fairly
  13.     "intelligent"; it can usually figure out where a message is going, and
  14.     will print an appropriate header when it can.
  15.          WWIVEdit is an evolving software product.  It may never be
  16.     complete, but its getting there.
  17.  
  18.  
  19.                            INSTALLATION INSTRUCTIONS
  20.  
  21.          WWIVEdit is very easy to install... In fact, it will install
  22.     itself.  All you have to do is unzip the distribution file into a
  23.     temporary directory, and then type INSTALL.
  24.  
  25.          The install program will prompt you for your WWIV directory, and
  26.     where you want to install WWIVEdit to, and then create the needed
  27.     directory structure and copy the proper files into place.  It will also
  28.     configure the command lines correctly for you, so the only thing you
  29.     have to do is make sure that you have a Logon event with %1 on the
  30.     command line.
  31.  
  32.          If by some odd chance the Install program can't/doesn't get the
  33.     command lines right, for reference, they are:
  34.  
  35.       Remote:
  36.          C:\WWIV\WWIVEDIT\WWIVEDIT %1 %2 %3 %4
  37.       Local:
  38.          C:\WWIV\WWIVEDIT\WWIVEDIT %1 %2 %3 %4 -key:local -set:local
  39.  
  40.     Assumming that your WWIV directory is C:\WWIV
  41.  
  42.     The install program for WWIVEdit will create the following directory
  43.     structure:
  44.  
  45.     ───WWIV────WWIVEDIT───┬─CONFIG
  46.                           ├─DICT
  47.                           └─DOC
  48.  
  49.     The WWIVEDIT directory should contain:
  50.     MACROS.LCL, NOTAG, TAGLINES.CMN, WWIVEDIT.EXE, WWIVEDIT.HLP,
  51.     WWIVEDIT.KEY, and WWIVEDIT.OVR
  52.  
  53.     TAGLINES.CMN is created after the first run of WWIVEdit.
  54.  
  55.     The CONFIG directory should contain:
  56.     LOCAL.DEF, LOCAL.KEY, DEFAULT.DEF, DEFAULT.KEY, ECLIPSE.DEF
  57.  
  58.     After the first run of WWIVEdit with a particular DEF and/or KEY file,
  59.     new files will appear.  For example, from LOCAL.DEF, LOCAL.SET will be
  60.     created, and from LOCAL.KEY, LOCAL.KBD will created.  These are the
  61.  
  62.  
  63.                                      - 1 -
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                               WWIVEdit Version 2.3
  70.                   By Adam Caldwell (1@16470 Link, 1@6470 Net)
  71.  
  72.  
  73.     binary forms of the "text" files.  They will be used the next time
  74.     WWIVEdit is run to speed up loading.
  75.  
  76.     The DOC directory contains various files (such as this one).
  77.  
  78.          That's all you need for the standard configuration if you are
  79.     running unmodified WWIV 4.xx, although, be sure to read the information
  80.     about Logon Events below.  You will also want to look at the
  81.     accompanying files called CONFIG.DOC and KEY.DOC.  They give a
  82.     comprehensive discussion of configuring WWIVEdit to your system.
  83.          If you have made any of the following changes to you BBS, you must
  84.     install the EDITINFO.MOD (included with WWIVEdit) otherwise incorrect
  85.     information will be displayed, and possibly confusion over taglines and
  86.     some of the other advanced features of WWIVEdit.
  87.       1) Modified your read/main menu prompt to something that does not
  88.          have a set of [] or <> around the message base name.
  89.       2) Modified any of the following "phrases", or changed the spacing of
  90.          them in the BBS:
  91.          "Title", "E-mail", "Post", "Multi-Mail", "Filename?"
  92.       3) You have added an option that allows a new user to select a full
  93.          screen editor before the "validation feedback"
  94.       4) You do not have and do not want to create a Logon Event
  95.  
  96.     Even if none of these applies to you and you have the WWIV Source code,
  97.     you are still strongly encouraged to install EDITINFO.MOD.
  98.  
  99.  
  100.     LOGON EVENT
  101.     -----------
  102.          For tag lines and user defaults to properly function, you must
  103.     always have an up-to-date CHAIN.TXT file (or install EDITINFO.MOD).
  104.     This file is updated when a user logs on if you have a logon event, so
  105.     you need to create one if you do not yet have one.
  106.          If you don't have one, or you are not sure, do the following:
  107.     1.  Run INIT.EXE which came with WWIV.
  108.     2.  Select Option #6 (External Programs)
  109.     3.  Move down to Logon Event
  110.     4.  If there is nothing there, enter LOGON.BAT %1.  If there is
  111.         something already there (and it has %1 on the command line), then
  112.         you are all done.  Otherwise see #5
  113.     5.  Press ESC a few times to exit INIT.EXE, and then create a file
  114.         called LOGON.BAT.  It need not contain anything, just create it.
  115.         A simple way to do this is to type
  116.         COPY CON LOGON.BAT
  117.         @Echo Welcome to <Insert BBS name here> [Enter]
  118.         press Control-Z and then [Enter]
  119.  
  120.  
  121.     EDITINFO.MOD
  122.     ------------
  123.          EDITINFO.MOD is a modification that I wrote so that WWIVEdit can
  124.     more effectively communicate with the BBS.  EDITINFO.MOD communicates
  125.     with the BBS through two different files.  The first file is called
  126.     EDITOR.INF.  The BBS creates this file before invoking the editor.
  127.  
  128.  
  129.                                      - 2 -
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                               WWIVEdit Version 2.3
  136.                   By Adam Caldwell (1@16470 Link, 1@6470 Net)
  137.  
  138.  
  139.     This file contains information about the messages's destination, title,
  140.     and information about its author.
  141.          The second file is created by WWIVEdit.  This file contain the
  142.     "Anonymous" state of the message just saved, and its title.
  143.  
  144.     Enhancements enabled by this modification:
  145.          /TI  : Title Change
  146.          /ESN : Non-Anonymous save without that annoying Anonymous? prompt
  147.          /ESY : Anonymous save without prompt
  148.          "Title:" and "Dest:" will always be correct
  149.          Fixes problems that appear under special situations (//CHUSER)
  150.  
  151.     Disadvantages:
  152.          Slows down loading very slightly for full screen editors other
  153.     than WWIVEdit.
  154.          Requires that you have the BBS source code.
  155.  
  156.  
  157.     MS-DOS 5.0
  158.     ----------
  159.     If you are running MS-DOS 5.0 and Wayne Bell's DOS 5.0 fix for WWIV
  160.     4.12, you need to do some additional work.  Go into RETURN.C and search
  161.     for ni_stack[100].  Change it to ni_stack[1024].  Next, search for
  162.     &ni_stack[98] and change it to &ni_stack[1022].  Repeat these in
  163.     EXTRN.C, and that should fix everything (including problems with other
  164.     editors).
  165.  
  166.  
  167.     TURBO C 2.0
  168.     -----------
  169.          I have heard that there is may be a problem if you compile WWIV
  170.     using Turbo C 2.0.  This may cause the editor to hang up your system.
  171.     If you are having problems with lockups on your system, try installing
  172.     a stock copy of WWIV 4.xx and see if WWIVEdit will work with it.  If it
  173.     doesn't, please let me know so I can correct the problem if possible.
  174.  
  175.  
  176.     BACKSPACE/DELETE
  177.     ----------------
  178.     WWIV 4.xx has a "bug" that causes the delete key to be mapped as the
  179.     backspace key.  What that means is that from remote, when the user
  180.     presses his delete key expecting the character under the cursor to be
  181.     deleted, the editor will instead delete the character to the left of
  182.     the cursor.  The EDITINFO.MOD included with WWIVEdit has a few steps in
  183.     it that will fix this bug for all external editors, without affecting
  184.     other externals or the internal WWIV editor.
  185.  
  186.     USER MACROS
  187.     -----------
  188.     User Macros are once again External to WWIVEdit.  To define a macro,
  189.     you must go into the defaults section of the BBS and select "Update
  190.     Macros".  From there you will choose Make, and then select either the
  191.     Control-A, Control-D, or Control-F macro.  If user macros are not
  192.     working correctly, modify the KEYBOARD parameter in the DEF file.
  193.  
  194.  
  195.                                      - 3 -
  196.  
  197.  
  198.  
  199.  
  200.  
  201.                               WWIVEdit Version 2.3
  202.                   By Adam Caldwell (1@16470 Link, 1@6470 Net)
  203.  
  204.  
  205.     LOCAL MACROS
  206.     ------------
  207.          Some sysops commented to me that they would like ALT-1 thru ALT-0
  208.     macros.  I took this to the extreme and allowed not only those, but
  209.     also Alt-F1 thru Alt-F10, Ctrl-F1 thru Ctrl-F10, Shift-F1 thru Shift-
  210.     F10, Alt-A thru Alt-Z, and F1 thru F10.  So...  If anyone needs more
  211.     than 10 macros, they can have them.  Each macro is limited to
  212.     approximately 1000 characters.  If anyone requires more than this for a
  213.     single macro, just say so, and I will increase it for you.
  214.          Local macros are stored in a file called MACROS.LCL which is a
  215.     text file that can be edited with WWIVEdit.  An example file is
  216.     provided with the editor.  This file, along with WWIVEDIT.KEY must be
  217.     in your WWIVEDIT directory.  You must also have WWIVEDITMACROS set to 1
  218.     in the DEF file that you are using (LOCAL.DEF).
  219.          To specify a macro in it, you have to first figure out what the
  220.     "name" of it is.  The following naming conventions are used:
  221.        "A"   thru "Z"   relate to Alt-A thru Alt-Z
  222.        "1"   thru "0"   relate to Alt-1 thru Alt-0
  223.        "F1"  thru "F0"  relate to F1 thru F10
  224.        "$F1" thru "$F0" relate to Shift-F1 thru Shift-F10
  225.        "^F1" thru "^F0" relate to Control-F1 thru Control-F10
  226.        "!F1" thru "!F0" relate to Alt-F1 thru Alt-F10
  227.        ^IN and $IN are Control Insert and Shift Insert
  228.        ^DL and $DL are Control Delete and Shift Delete
  229.        $TB is Shift Tab
  230.        HOM is the Home Key
  231.        END is the End Key
  232.        UP, RT, LF, and DN are the Arrow keys Up, Right, Left, and Down
  233.        PU and PD are Page Up and Page Down
  234.        INS and DEL are the insert and delete keys
  235.        ^LF and ^RT are Control Left Arrow and Control Right Arrow
  236.        ^PU and ^PD are Control Page Up and Control Page Down
  237.        ^HO and ^EN are Control Home and Control End
  238.        - and = are Alt -  and Alt =
  239.  
  240.     Many of the above keys are standard editing functions, and will be of
  241.     no practical use as macro names, but they are included just in case.
  242.  
  243.     To specify a macro, you need to use the following layout:
  244.     NAME:
  245.     Macro Text Line 1
  246.     Macro Text Line 2
  247.     .
  248.     .
  249.     Macro Text Line N
  250.     :NAME
  251.  
  252.          The Tilde (~) has special meaning when it appears at the beginning
  253.     or end of a line.  When it appears at the beginning of a line, it
  254.     serves as a place holder and is ignored when the macro is executed.
  255.     This is very helpful if you want your macro to end with a "slash"
  256.     command.  For example, say you wanted to make an F2 macro that saved
  257.     your message.  If you simply Typed
  258.     "F2: [ENTER] /ES [ENTER]", it would save the Macros file (assuming you
  259.  
  260.  
  261.                                      - 4 -
  262.  
  263.  
  264.  
  265.  
  266.  
  267.                               WWIVEdit Version 2.3
  268.                   By Adam Caldwell (1@16470 Link, 1@6470 Net)
  269.  
  270.  
  271.     are using WWIVEdit to edit the macros file).  On the other hand, this
  272.     macro would do what you want:
  273.  
  274.     F2:
  275.     ~/ES
  276.     :F2
  277.  
  278.     When a tilde appears at the end of a line, it means that no carriage
  279.     return should be sent during macro execution.  This is useful if you
  280.     don't want a new line to be started after the macro is done executing.
  281.     Extending the above macro's second line to ~/ES~ would make it so that
  282.     you would have to hit ENTER after pressing F2 to save the file, in case
  283.     you accidently hit F2.
  284.  
  285.     Also, there is no reason why you can't have colors or even use the ^N
  286.     keys (assuming that you are editing MACROS.LCL with WWIVEdit).  You can
  287.     even insert control characters, such as ESC by first hitting ^Q, and
  288.     then hitting ESC....
  289.  
  290.  
  291.     CHAT MODE
  292.     ---------
  293.          WWIVEdit supports a two-way color chat that looks very similar to
  294.     the Two-Way chat mode in WWIV 4.xx.  You can enter chat mode by
  295.     pressing both shift keys at the same time (or whatever you define it as
  296.     in the .DEF file.)  The chat mode is so similar to the BBS chat mode
  297.     that most of my users didn't notice the difference until I pointed it
  298.     out to them.
  299.          There is only one known problem with the Two-Way chat mode in
  300.     WWIVEdit.  If the user should happen to hang up/get disconnected while
  301.     in chat mode, the BBS will lock-up the next time a key is pressed on
  302.     the keyboard.  This shouldn't be a problem because the only way to get
  303.     into chat mode is for the sysop to be there, and if the user hangs up
  304.     in chat mode, the sysop will be there to reset the BBS (and computer).
  305.     There will be no ill effects if the user should hang up during normal
  306.     message entering because all keyboard I/O is done through normal BBS
  307.     means.
  308.  
  309.  
  310.     TAG LINES
  311.     ---------
  312.          WWIVEdit supports two kinds of tag lines.  Personal Tag Lines, and
  313.     BBS Tag Lines.  Both are optional.  Personal Tag Lines are defined by
  314.     the user, and are appended to every message that the user posts unless
  315.     he saves it with /SY or /ESY, or they disable taglines for a particular
  316.     message, or you have set up NOTAG files.  Taglines are fairly self
  317.     explanatory to the user.  The only thing that the sysop needs to know
  318.     is that, at his option, NO USER can have tag lines.  To invoke this
  319.     power edit the DEFAULT.DEF file and set TAGLINES to 1.
  320.          BBS Tag lines are definable by the Sysop.  To create BBS Tag
  321.     Line(s), create a file called BBS*.TAG.  The * can be anything you
  322.     want, and you can create as many of these files as you want.  If more
  323.     than one of them exists, WWIVEdit will select one at Random and append
  324.     it to the message.  If at some time you wish to disable these tag lines
  325.  
  326.  
  327.                                      - 5 -
  328.  
  329.  
  330.  
  331.  
  332.  
  333.                               WWIVEdit Version 2.3
  334.                   By Adam Caldwell (1@16470 Link, 1@6470 Net)
  335.  
  336.  
  337.     without deleting the files, you can change the BBSTAG setting in the
  338.     DEFAULT.DEF file to 1.
  339.          A new feature in WWIVEdit 2.2 is the ability to disable Tag Lines
  340.     on selected message bases.  Edit the file in your WWIVEDIT directory
  341.     called NOTAG.  The default file that comes with WWIVEdit contains only
  342.     the symbol #.  What this does is disable Tag Lines on Non-Networked
  343.     personal E-Mail.  Here is how NOTAG works.
  344.          WWIVEdit will check each line in the NOTAG file to see if it is a
  345.     "substring" of the DEST: line.  Whenever personal E-Mail is sent on a
  346.     system the Dest: line will appear as "User Name #10" or whatever.  In
  347.     this case, the "#" in the NOTAG file matches the "#" in the "#10".
  348.          You are not limited to symbols though.  You can just as easily
  349.     type in a full message base name (these are CASE SENSITIVE).  For
  350.     Example, if you have a word association base and you don't want
  351.     Tag lines in it, your NOTAG file would look like this:
  352.     -----
  353.     #
  354.     Word Association
  355.     -----
  356.          If you have not installed the EDITINFO.MOD, then at times, the
  357.     DEST: line will be non-descript.  When WWIVEdit can't tell where a
  358.     message is going, it will simply say "Message Base".  You can add this
  359.     line to your NOTAG file if you are subscribed to a Sub that doesn't
  360.     allow Tag Lines because if you don't, when someone uses "W" or "P" to
  361.     post a message, its going to get a tag line attached to it.
  362.  
  363.     DISCLAIMER
  364.     ----------
  365.     WWIVEdit is a name that I arbitrarily choose in the process of writing
  366.     this program.  If there is any other editor out there that uses this
  367.     name, it is unknown to me.  WWIVEdit is the product of the work of Adam
  368.     Caldwell.  All routines used in this program were either written by
  369.     Adam Caldwell, or directly modified to suit the purposes of this
  370.     program with the following exceptions:
  371.        EXECSWAP unit by TurboPower software
  372.  
  373.          The Author of this program is not responsible for any damages,
  374.     frustrations, or other things that may result from the use of this
  375.     program, nor does he guarantee that it will work on any system but his
  376.     own.  This program is provided As-Is.  The Author will make
  377.     modifications specifically requested by people who donate money, and
  378.     may even do it for people who have not donated money, however, the
  379.     Author does not guarantee this.
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                      - 6 -
  394.  
  395.  
  396.  
  397.  
  398.  
  399.                               WWIVEdit Version 2.3
  400.                   By Adam Caldwell (1@16470 Link, 1@6470 Net)
  401.  
  402.  
  403.     PLEA FOR MONEY!
  404.     ---------------
  405.     WWIVEdit is distributed on a BegWare basis (I beg you to send me
  406.     money!).  If you find this program useful, PLEASE send me some money.
  407.     If you send me $10 or more and create an account for me on your BBS (or
  408.     your BBS is Snarfable), the newest version (or next version) will be
  409.     uploaded to your BBS for free, provided you follow the directions given
  410.     below.
  411.          1) Create an account with the name "THE EMPORER" (must be spelled
  412.             EXACTLY like that), with a password of your choice, and a phone
  413.             number ending in "2041" (or state that the BBS is Snarfable).
  414.          2) Send me the BBS's phone number... Otherwise, I don't know who
  415.             to call!
  416.          3) You must have a HST or V.32 modem running at 9600+
  417.  
  418.     If you don't have a high speed modem, then I will send you future
  419.     version on diskette.
  420.          This program may be freely distributed, so long as no fee is
  421.     charged for it.  All future version of this program will be distributed
  422.     in a BegWare fashion.  My BBS phone number is (614) 593-7836.  I don't
  423.     gaurantee that it will always be in service, but barring unforeseen
  424.     hardships, it will be in service until June 1993.
  425.  
  426.     I can be contacted at:
  427.       Adam Caldwell             (Preferred till June 1993)
  428.       114 Grosvenor St
  429.       Athens, Ohio 45701
  430.     OR
  431.       Adam Caldwell
  432.       16952 Nash Rd
  433.       Middlefield, Oh 44062
  434.  
  435.     If you have internet, you can E-Mail me at any of the following:
  436.       acaldwel@oucsace.cs.ohiou.edu
  437.       acaldwel@bigbird.cs.ohiou.edu
  438.     Note: I can't respond to UUCP mail because of our system setup.
  439.  
  440.     And finally, (the preffered method) via WWIV Net/Link
  441.       1 @16470 Link  The First Galactic Empire (Link)
  442.       1 @6470  Net   The First Galactic Empire (Net)
  443.     718 @5252  Net   The Dragon's Den (Net)  [If all else fails]
  444.  
  445.     Thank you for trying WWIVEdit
  446.       The Emporer
  447.       Sysop of "The First Galactic Empire"
  448.       Tel: (614) 593-7836 (WWIV 4.21, WWIVLink node 16401 USR HST DS 16.8K)
  449.            (614) 594-3051 (Voice)
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                                      - 7 -
  460.  
  461.  
  462.  
  463.  
  464.  
  465.                               WWIVEdit Version 2.3
  466.                   By Adam Caldwell (1@16470 Link, 1@6470 Net)
  467.  
  468.  
  469.                                 THANK YOU NOTES
  470.  
  471.     The Duelist - For Beta Testing my editor, getting me involved in WWIV,
  472.          and helping me set up my board so long ago...
  473.     Jim Wire - For help beyond the call of duty...
  474.     Trader Jack - For the initial beta testing of WWIVEdit 2.3
  475.     Niloc - For his suggestions and beta testing of the editor on my
  476.          system.
  477.  
  478.     Thanks also go to:
  479.       Parapuke, Filo, Trojan, Ken, Aahz, Lance Halle, Raistlin, Blondie &
  480.     The Warden, Phantom, Joe Hallahan, Gene Wells, and anyone everone who
  481.     sent me suggestions and bug reports (and more importanly, money).
  482.  
  483.  
  484.                                    WHAT'S NEW
  485.     Version 2.3
  486.     -----------
  487.     - Added Configurable defaults
  488.     - Added Configurable Key Bindings
  489.     - Added Install program
  490.     - Fixed a pesky bug that caused a blank to appear after the cursor if
  491.       you backspace while the cursor was at the end of a line and there was
  492.       no text after the current line (Gee, how many of you figured out that
  493.       this one actually existed? :)
  494.     - Fixed some range checking problems having to do with cursor movement
  495.     - Another significant re-arangement of the source
  496.     - Added several new functions such as delete word right, cursor to top
  497.       of page, cursor to bottom of page, block write to file, and several
  498.       others
  499.     - Added a defaults section for the users
  500.     - Major rewrite of the spell checker
  501.     - More color changes
  502.     - Added ability to select between pure DOS output and direct video
  503.       writes
  504.     - Added smooth local scrolling similar to FEdit
  505.     - Added local mouse support
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.                                      - 8 -
  526.  
  527.  
  528.  
  529.